<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>papyros.distributed.PyroTaskDispatcherProxy</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >papyros documentation</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="papyros-module.html">Package&nbsp;papyros</a> ::
        <a href="papyros.distributed-module.html">Module&nbsp;distributed</a> ::
        Class&nbsp;PyroTaskDispatcherProxy
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="papyros.distributed.PyroTaskDispatcherProxy-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class PyroTaskDispatcherProxy</h1><span class="codelink"><a href="papyros.distributed-pysrc.html#PyroTaskDispatcherProxy">source&nbsp;code</a></span><br /><br />
<pre class="base-tree">
Pyro.core.DynamicProxy --+
                         |
                        <strong class="uidshort">PyroTaskDispatcherProxy</strong>
</pre>

<hr />
<p>A proxy class of <a 
  href="papyros.distributed.PyroTaskDispatcher-class.html" 
  class="link">PyroTaskDispatcher</a>.</p>
  Clients interact with instances of this class instead of actual <a 
  href="papyros.distributed.PyroTaskDispatcher-class.html" 
  class="link">PyroTaskDispatcher</a> instances. The differences are that 
  <a href="papyros.base.TaskDispatcher-class.html#execute" 
  class="link">execute</a> is invoked locally on the client and that <a 
  href="papyros.distributed.PyroTaskDispatcherProxy-class.html#close" 
  class="link">close</a> and <a 
  href="papyros.distributed.PyroTaskDispatcherProxy-class.html#run" 
  class="link">run</a> are not accesible remotely.<br /><br />

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="papyros.distributed.PyroTaskDispatcherProxy-class.html#execute" class="summary-sig-name">execute</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">tasks</span>,
        <span class="summary-sig-arg">timeout</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">ordered</span>=<span class="summary-sig-default">False</span>,
        <span class="summary-sig-arg">chunksize</span>=<span class="summary-sig-default">1</span>,
        <span class="summary-sig-arg">qsize</span>=<span class="summary-sig-default">0</span>)</span><br />
      Execute the given tasks.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="papyros.base-pysrc.html#TaskDispatcher.execute">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="run"></a><span class="summary-sig-name">run</span>(<span class="summary-sig-arg">self</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="papyros.distributed-pysrc.html#PyroTaskDispatcherProxy.run">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="close"></a><span class="summary-sig-name">close</span>(<span class="summary-sig-arg">self</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="papyros.distributed-pysrc.html#PyroTaskDispatcherProxy.close">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>Pyro.core.DynamicProxy</code></b>:
      <code>__coerce__</code>,
      <code>__copy__</code>,
      <code>__deepcopy__</code>,
      <code>__del__</code>,
      <code>__eq__</code>,
      <code>__getattr__</code>,
      <code>__getstate__</code>,
      <code>__hash__</code>,
      <code>__init__</code>,
      <code>__ne__</code>,
      <code>__nonzero__</code>,
      <code>__repr__</code>,
      <code>__setstate__</code>,
      <code>__str__</code>
      </p>
    <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code>Pyro.core.DynamicProxy</code></b> (private):
      <code>_invokePYRO</code>,
      <code>_release</code>,
      <code>_setIdentification</code>,
      <code>_setNewConnectionValidator</code>,
      <code>_setOneway</code>,
      <code>_setTimeout</code>,
      <code>_transferThread</code>
      </p></div>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="execute"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">execute</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">tasks</span>,
        <span class="sig-arg">timeout</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">ordered</span>=<span class="sig-default">False</span>,
        <span class="sig-arg">chunksize</span>=<span class="sig-default">1</span>,
        <span class="sig-arg">qsize</span>=<span class="sig-default">0</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="papyros.base-pysrc.html#TaskDispatcher.execute">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  Execute the given tasks.
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>tasks</code></strong> - An iterable of <a href="papyros.task.Task-class.html" 
          class="link">tasks</a> to be executed.</li>
        <li><strong class="pname"><code>timeout</code></strong> - An upper bound of how long is a task expected to take. Useful 
          to prevent waiting for tasks that take forever to complete for 
          whatever reason.</li>
        <li><strong class="pname"><code>ordered</code></strong> - If True, the order of the yielded results matches the the 
          order of the tasks that generated them. If False, the results' 
          order is unspecified.</li>
        <li><strong class="pname"><code>chunksize</code></strong> - The <code>tasks</code> iterable is chunked into slices of this
          size (or less) before being submitted to the dispatcher and 
          workers.</li>
        <li><strong class="pname"><code>qsize</code></strong> - The <a href="papyros.base.TaskQueue-class.html#__init__" 
          class="link">size</a> of the underlying task queue.</li>
    </ul></dd>
    <dt>Returns:</dt>
        <dd>An iterator over the results of the executed tasks.</dd>
    <dt>Raises:</dt>
    <dd><ul class="nomargin-top">
        <li><code><strong class='fraise'><a href="papyros.TimeoutError-class.html">TimeoutError</a></strong></code> - If a call to the returned iterator's <code>next()</code> exceeds
        the <code>timeout</code>.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >papyros documentation</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0beta1 on Tue Aug 12 05:39:45 2008
    </td>
    <td align="right" class="footer">
      <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie()
  // -->
</script>
  
</body>
</html>
